Kotlin Multiplatform Client for Docker/dev.limebeck.libs.docker.client.api/System

System

class System(dockerClient: DockerClient)

Docker system operations using the owning DockerClient.

Result-returning methods report daemon HTTP errors as ErrorResponse. Transport/decoding failures and cancellation can throw. Live flows report request failures during collection.

Constructors

System

constructor(dockerClient: DockerClient)

Functions

dataUsage

suspend fun dataUsage(): Result<SystemDataUsageResponse, ErrorResponse>

Get data usage information

events

fun events(since: String? = null, until: String? = null, filters: Map<String, List<String>>? = null): Flow<EventMessage>

Returns a cold event flow: each collection opens a separate request. HTTP errors throw dev.limebeck.libs.docker.client.model.DockerApiException. Malformed JSON events are skipped; transport and collector failures propagate. Cancellation or completion releases the request. There is no automatic reconnect. Docker history is finite: save a cursor, deduplicate replay and refresh resource state after reconnect. An interrupted connection may also finish as normal EOF.

getInfo

suspend fun getInfo(): Result<SystemInfo, ErrorResponse>

Get system information

getVersion

suspend fun getVersion(): Result<SystemVersion, ErrorResponse>

Get version

ping

suspend fun ping(): Result<Unit, ErrorResponse>

Ping